.TH MSTFWMANAGER "1" "March 2020" "mstflint" "User Commands"
.SH NAME
mstfwmanager \- Mellanox Firmware Manager
.SH DESCRIPTION
NAME
.IP
mstfwmanager
.PP
SYNOPSIS
.IP
mstfwmanager
.IP
[\-d|\-\-dev DeviceName] [\-h|\-\-help] [\-v|\-\-version] [\-\-query] [\-\-query\-format Format]
[\-u|\-\-update] [\-i|\-\-image\-file FileName] [\-D|\-\-image\-dir DirectoryName] [\-f|\-\-force]
[\-\-no_fw_ctrl] [\-y|\-\-yes] [\-\-no] [\-\-clear\-semaphore] [\-\-exe\-rel\-path]
[\-l|\-\-list\-content] [\-\-archive\-names] [\-\-nofs] [\-\-log] [\-L|\-\-log\-file LogFileName]
[\-\-no\-progress] [\-o|\-\-outfile OutputFileName] [\-\-online] [\-\-online\-query\-psid PSIDs]
[\-\-key key] [\-\-download DirectoryName] [\-\-download\-default] [\-\-get\-download\-opt OPT]
[\-\-download\-device Device] [\-\-download\-os OS] [\-\-download\-type Type]
[\-\-ssl\-certificate Certificate]
.PP
DESCRIPTION
.IP
Mellanox Firmware Manager
.PP
OPTIONS
.IP
mstfwmanager
.TP
\fB\-d\fR|\-\-dev DeviceName
: Perform operation for specified mst
device(s). Run 'mst status' command to list
the available devices. Multiple devices can
be specified delimited by semicolons. A
device list containing semicolons must be
quoted.
.TP
\fB\-h\fR|\-\-help
: Show this message and exit
.TP
\fB\-v\fR|\-\-version
: Show the executable version and exit
.TP
\fB\-\-query\fR
: Query device(s) info
.TP
\fB\-\-query\-format\fR Format
: (Query | Online query) output format, XML |
Text \- default Text
.TP
\fB\-u\fR|\-\-update
: Update firmware image(s) on the device(s)
.TP
\fB\-i\fR|\-\-image\-file FileName
: Specified image file to use
.TP
\fB\-D\fR|\-\-image\-dir DirectoryName
: Specified directory instead of default to
locate image files
.TP
\fB\-f\fR|\-\-force
: Force image update
.TP
\fB\-\-no_fw_ctrl\fR
: Don't use FW Ctrl update
.TP
\fB\-y\fR|\-\-yes
: Answer is yes in prompts
.TP
\fB\-\-no\fR
: Answer is no in prompts
.TP
\fB\-\-clear\-semaphore\fR
: Force clear the flash semaphore on the
device, No command is allowed when this flag
is used. NOTE: May result in system
instability or flash corruption if the
device or another application is currently
using the flash. Exercise caution.
.TP
\fB\-\-exe\-rel\-path\fR
: Use paths relative to the location of the
executable
.TP
\fB\-l\fR|\-\-list\-content
: List file/Directory content, used with
\fB\-\-image\-dir\fR and \fB\-\-image\-file\fR flags
.TP
\fB\-\-archive\-names\fR
: Display archive names in listing
.TP
\fB\-\-nofs\fR
: Burn image in a non failsafe manner
.TP
\fB\-\-log\fR
: Create log file
.TP
\fB\-L\fR|\-\-log\-file LogFileName
: Use specified log file
.TP
\fB\-\-no\-progress\fR
: Do not show progress
.TP
\fB\-o\fR|\-\-outfile OutputFileName
: Write to specified output file
.TP
\fB\-\-online\fR
: Fetch required FW images online from Mellanox
server
.TP
\fB\-\-online\-query\-psid\fR PSIDs
: Query FW info, PSID(s) are comma separated
.TP
\fB\-\-key\fR key
: Key for custom download/update
.TP
\fB\-\-download\fR DirectoryName
: Download files from server to a specified
directory
.TP
\fB\-\-download\-default\fR
: Use Default values for download
.TP
\fB\-\-get\-download\-opt\fR OPT
: Get download options for OS or Device
Options are: OS, Device
.TP
\fB\-\-download\-device\fR Device
: Use '\-\-get\-download\-opt Device' option to
view available devices for device specific
downloads
.TP
\fB\-\-download\-os\fR OS
: Only for self_extractor download: Use
\&'\-\-get\-download\-opt OS' option to view
available OS for sfx download
.TP
\fB\-\-download\-type\fR Type
: MFA | self_extractor \- default All
.TP
\fB\-\-ssl\-certificate\fR Certificate
: SSL certificate For secure connection
.SH EXAMPLES
.IP
1. Query specific device or all devices (if no device were supplied)
>> mstfwmanager [\-d <device>] [\-\-query]
2. Burn device with specific image / MFA / images directory
>> mstfwmanager \-d <device> [\-i <image file/MFA file> | \-D <images dir>]
3. Update the card's firmware
>> mstfwmanager \-u
4. Update the card's firmware from latest version on the web
>> mstfwmanager \-\-online \-u
5. Download latest FW package from the web
>> mstfwmanager \-\-download\-default \-\-download\-os Linux_x64 \-\-download\-type self_extractor
.SH "SEE ALSO"
.B mstflint(1)
